/*
 * $Id$
 * 
 * Copyright (c) 2006 Fran Lattanzio
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

package org.teneighty.fft;

import java.io.Serializable;


/**
 * Direction enum.
 * 
 * @author Fran Lattanzio
 * @version $Revision$ $Date$
 */
public enum TransformDirection
	implements Serializable
{
	
	/**
	 * Forward.
	 */
	FORWARD( "Forward" ),
	
	/**
	 * Backward/inverse.
	 */
	BACKWARD( "Backward (inverse)." );
	
	
	/**
	 * Serial version UID.
	 */
	private static final long serialVersionUID = 9238234L;
	
	
	/**
	 * Description.
	 */
	private String desc;
	
	
	/**
	 * Initializer.
	 * 
	 * @param desc the description.
	 */
	private TransformDirection( final String desc )
	{
		this.desc = desc;
	}
	
	
	/**
	 * Get the description.
	 * 
	 * @return String the description.
	 */
	public String getDescription()
	{
		return( this.desc );
	}
			
	
}
